docs: add a description to every docs page - #78
Merged
Conversation
Only 6 of 76 pages carried a description in frontmatter. Every page without one gives search results, og:description, the docs search snippet and any generated index nothing to show but a title. Each description is one line drawn from the page's own opening, under 130 characters, and says what the page covers rather than restating its title.
kparisa
approved these changes
Sep 3, 2026
kparisa
left a comment
kparisa
left a comment
Contributor
There was a problem hiding this comment.
This is great @justinmclean we can always refine these descriptions as needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Only 6 of 76 pages carried a description in frontmatter. Each description is one line drawn from the page's own opening, under 130 characters, and says what the page covers rather than restating its title.